Documentation by Codefir
Thank you for purchasing phpSound software. If you have any questions that are beyond the scope of this documentation, please feel free to contact us trough this form.

1. Preparing - top

Make sure you have the following:
  1. Apache 2 or higher, with:
    • mod_rewrite
  2. PHP 7 or higher, with:
    • MySQLi
    • cURL
    • OpenSSL
    • GD
    • mbstring
  3. MySQL 5 or higher

2. Installation Process - top

  1. Import the phpSound.SQL file from the "MySQL" folder into your MySQL database using the import function available in MySQL.
  2. With a text editor open the following file located inside the 'Script/includes/' folder: config.php, and replace what's between the quotes (e.g: 'YOURDBNAME') with your MySQL settings:
    	$CONF['user'] = 'YOURDBUSER';
    	$CONF['pass'] = 'YOURDBPASS';
    	$CONF['name'] = 'YOURDBNAME';
    	$CONF['url'] = 'http://yourdomain.com';
    	$CONF['email'] = 'notifications@yourdomain.com';
    	
  3. Upload the files from the "Script" folder on the FTP server (usually public_html folder when installing it on a domain).
  4. Set the CHMOD to 777, 775 or 775 (depending on the server configuration) to the following folders: '/cache', '/uploads' and its subfolders: '/uploads/avatars', '/uploads/covers', '/uploads/media', '/uploads/tracks' and '/themes/theme-name/images'.

3. Configuration - top

The default username for the Admin is "admin", and the password is "password" without quotes (the admin panel link is located in footer).

  • Dashboard
  • Shows you quick statistics and performance of the current day along with graphs for the last 7 days, site information and useful links.

  • Site Settings
  • Allows you to change the website settings such as general, registration, emails and limits.
      Enabling Facebook Login
    1. Go to developers.facebook.com and create a Add a new App.
    2. Select the Facebook Login product and click Set up and choose the Web Platform.
    3. On Step 1 add your Site URL and click Save. Skip the rest of the steps.
    4. From the sidebar, under Facebook Login click on Settings and disable Client OAuth Login and Use Strict Mode for Redirect URIs
    5. Under Valid OAuth redirect URIs add the following URL: https://yourdomain.com/requests/connect.php?facebook=true (replace yourdomain.com with your own domain name), and Save the changes.
    6. Go to your App Settings page, and copy the App ID and App Secret keys which you can use to enable Facebook Login.
      Enabling Amazon S3 Storage
    1. Sign up for Amazon S3
    2. Create a Bucket
    3. Get your Access Key ID and Secret Access Key
    4. You can now enable the Amazon S3 storage from the Admin Panel by adding the Key, Secret, Region, Bucket and enabling Amazon S3 Storage.
  • Pro Accounts
  • Allows you to enable or disable Pro Accounts, change settings such as upload size, monthly plans, currency, etc.
      How to enable PayPal Payments
    1. Login into your PayPal account and click on Profile.
    2. Then go to My Selling Tools and Update your API Access.
    3. Pick Option 2 which is Request API credentials.
    4. Now choose Request API signature, hit Agree and Submit and copy the "API Username", "API Password" and "Signature".
    5. You can now enable Pro Accounts from the Admin Panel by adding the "API Username", "API Password", and "API Signature" and enabling Pro Accounts.
      How to enable PayPal IPN
    1. Login into your PayPal account and click on Profile
    2. Then go to My Selling Tools and Update your Instant payment notifications.
    3. Click the Choose IPN Settings, set Notification URL to http://yoursite.com/requests/listener.php and choose Receive IPN messages (Enabled), save.
      List of supported currencies
  • Themes
  • Allows you to change the whole website layout, the current theme enabled is marked Active.

  • Languages
  • Allows you to set the default website language.

  • Statistics
  • Advanced user and site statistics User Registrations, Tracks, Comments, Reports, Likes, Earnings and more.

  • Password
  • Allows you to change the Administrator Password.

  • Manage Users
  • Allows you to edit users, promote, suspend, delete accounts, view transaction history and more.

  • Manage Payments
  • Allows you to view the payments details, suspend or enable a certain payment.

  • Manage Reports
  • Allows you to manage the reported Tracks and Comments, like suspending or deleting them.

  • Manage Categories
  • Allows you to add certain categories that will be displayed on the "Explore" page.

  • Manage Ads
  • Allows you to add Advertisments in certain places on the website.

  • Info Pages
  • Create informative pages such as Contact, About, etc. for your website.

  • Newsletter
  • Allows you to send a newsletter email to all the registered users.

    4. FAQ - top

    1. Q: I want to modify a text or something about the design...
      A: You can change anything visual from the theme located in: /themes/theme-name

    2. Q: I want to change the website's logo or site title.
      A: You can change the Logo or the Site title from the Admin Panel > Site Settings > General tab.

    3. Q: How are the Track Plays counted?
      A: Track plays are added at the end of the track.

    4. Q: The "Go Pro" suggestions don't appear on sidebar for new users.
      A: The widget will appear as soon as the user uploads a track.

    5. Q: What happens if I suspend a track due to a DMCA complain?
      A: The track won't be available to that user anymore (the track will remain on server), also both the copyright claimer and the abuser will be informed via email.

    6. Q: What happens if I delete a track due to a DMCA complain?
      A: The track will be permanently removed from your server.

    7. Q: What happens if I suspend a payment?
      A: The payment won't be taken in consideration by the software anymore, unless you Enable it back.

    8. Q: How are the Popular tracks being generated on the homepage?
      A: Popular tracks are being generated based on the amount of plays from the last 24 hours.

    9. Q: I want to change the Timezone for my website.
      A: You can add a custom Timezone by going to Admin Panel > Site Settings > General tab, the available list of timezones can be found at PHP Timezones.

    10. Q: I have problems/questions related to the script, how can I contact you?
      A: You can contact us trough this contact form.

    5. Developers - top

    As a developer, the only mandatory requirement is a valid phpSound license key.

    Themes

    • Make a copy of the default 'sound' theme, and rename the folder into your theme's name.
    • Edit info.php with your own details [Author, Version, etc].
    • Edit icon.png with your own theme icon.
    • Have fun designing your theme.
    Recommendations:
    • Theme's folder name should not contain any white spaces.
    • Edit the original 'sound' theme, as it contains all the strings and files required.

    Languages

    • Make a copy of the original 'english.php' file into the /languages/ folder, rename it into your language and then start translating it.
    • If you're using special characters, save the file using UTF-8 without BOM.
    Copyright © phpSound. All rights reserved.
    A product by Codefir.